home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / programming / gui / gadtoolsbox20c.lha / GadToolsBox / GTXLib / Docs / TextClass.doc < prev    next >
Text File  |  1993-04-01  |  2KB  |  59 lines
  1. Class:          textclass
  2. Superclass:     imageclass
  3. Include File:   <gadtoolsbox/textclass.h>
  4.  
  5. This class is an extension to the existing imageclass. It is ment to be used
  6. to provide the creators of new boopsi/gadtools gadgets a simple but effective
  7. way to support gadget texts including 2.0 style border rendering.
  8.  
  9. New Methods:
  10.  
  11. None.
  12.  
  13. Changed Methods:
  14.  
  15. None.
  16.  
  17. Supported Methods:
  18.  
  19. OM_NEW, IM_ERASE, IM_DRAW, OM_SET, OM_UPDATE. All other methods are directly
  20. passed onto the superclass dispatcher.
  21.  
  22. Attributes:
  23.  
  24. IA_Left, IA_Top, IA_Width, IA_Height (I) - These attributes should be used to
  25. define the position and dimensions of the box. The text is always rendered
  26. relative to the box position and dimensions.
  27.  
  28. TX_TextAttr (ISU) - This attribute contains a pointer to a TextAttr structure
  29. (defined in <graphixs/text.h>) describing which font to use for rendering the
  30. text. When this is NULL the default font is used to render the text. The font
  31. will be opened using OpenFont() so it must be resident in memory.
  32.  
  33. TX_Style (ISU) - This attribute contains font style flags (defined in
  34. <graphics/text.h>). The style flags described here will over-ride the style flags
  35. that are set in the TextAttr structure.
  36.  
  37. TX_ForceTextPen (ISU) - This attribute contains a pen number which is used to
  38. render the text. Normally the TEXTPEN, FILLTEXTPEN or HIGHLIGHTTEXTPEN is used to
  39. render the text. When setting this attribute to something else than ~0 will force
  40. the dispatcher to render the text using the described pen.
  41.  
  42. TX_Underscore (ISU) - This attribute contains the character code which is used
  43. to mark the character that needs to be underscored. The underscored character is
  44. normally used to indicate a keyboard shortcut for a gadget.
  45.  
  46. TX_Flags (ISU) -  This attribute contains the place where the text must be rendered
  47. and wether or not the text must be rendered using the highligh text pen. The places
  48. are always relative to the box position and dimensions passed to the class dispatcher
  49. at creation time. Currently the places PLACETEXT_IN, PLACETEXT_LEFT, PLACETEXT_RIGHT,
  50. PLACETEXT_ABOVE and PLACETEXT_BELOW (defined in <libraries/gadtools.h>) are supported.
  51. Also the NG_HIGHLABEL flags is supported but the TX_ForceTextPen will override this
  52. flag.
  53.  
  54. TX_Text (ISU) - This attribute contains the null terminated string which must be
  55. rendered.
  56.  
  57. SPTX_NoBox (ISU) - This attribute is a boolean which must read TRUE if you do not
  58. want a bevelled box drawn at the box position and dimensions.
  59.